<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>Aria: ArCondition Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Aria
   &#160;<span id="projectnumber">2.9.1</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li><a href="examples.html"><span>Examples</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classArCondition.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="#pro-static-attribs">Static Protected Attributes</a> &#124;
<a href="classArCondition-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">ArCondition Class Reference<div class="ingroups"><a class="el" href="group__UtilityClasses.html">Utility Classes</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>Threading condition wrapper class.  
 <a href="classArCondition.html#details">More...</a></p>

<p><code>#include &lt;ArCondition.h&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a4382a649f89fb9d07ab9f58b19a6d936"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom">{ <br />
&#160;&#160;<a class="el" href="classArCondition.html#a4382a649f89fb9d07ab9f58b19a6d936a3f6f29f645b2ea501e9488a4d96ea6f4">STATUS_FAILED</a> =1, 
<a class="el" href="classArCondition.html#a4382a649f89fb9d07ab9f58b19a6d936ae43052d595425a1bfe513b595644ad45">STATUS_FAILED_DESTROY</a>, 
<a class="el" href="classArCondition.html#a4382a649f89fb9d07ab9f58b19a6d936aa37fed77069fa1ac5d22adb77bbf361e">STATUS_FAILED_INIT</a>, 
<a class="el" href="classArCondition.html#a4382a649f89fb9d07ab9f58b19a6d936ae06d2c7cba91b1db65a1d7beceba88ba">STATUS_WAIT_TIMEDOUT</a>, 
<br />
&#160;&#160;<a class="el" href="classArCondition.html#a4382a649f89fb9d07ab9f58b19a6d936a1d3f032f0e06ee4095a1feb7e3af00f5">STATUS_WAIT_INTR</a>, 
<a class="el" href="classArCondition.html#a4382a649f89fb9d07ab9f58b19a6d936adeeec5c6ab916d4c79763f3e9e548e07">STATUS_MUTEX_FAILED_INIT</a>, 
<a class="el" href="classArCondition.html#a4382a649f89fb9d07ab9f58b19a6d936a55ca5a24fcc970ab4df4119c881ead71">STATUS_MUTEX_FAILED</a>
<br />
 }</td></tr>
<tr class="separator:a4382a649f89fb9d07ab9f58b19a6d936"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2849eecdd137e22386c433c1b4c920ef"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2849eecdd137e22386c433c1b4c920ef"></a>
typedef pthread_cond_t&#160;</td><td class="memItemRight" valign="bottom"><b>CondType</b></td></tr>
<tr class="separator:a2849eecdd137e22386c433c1b4c920ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a884fc06f69e555ed143081716e9acc14"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a884fc06f69e555ed143081716e9acc14"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArCondition.html#a884fc06f69e555ed143081716e9acc14">ArCondition</a> ()</td></tr>
<tr class="memdesc:a884fc06f69e555ed143081716e9acc14"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
<tr class="separator:a884fc06f69e555ed143081716e9acc14"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7f5564bc60a636bcedcbb9eb6a0304ff"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7f5564bc60a636bcedcbb9eb6a0304ff"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArCondition.html#a7f5564bc60a636bcedcbb9eb6a0304ff">broadcast</a> ()</td></tr>
<tr class="memdesc:a7f5564bc60a636bcedcbb9eb6a0304ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Broadcast a signal to all threads waiting. <br /></td></tr>
<tr class="separator:a7f5564bc60a636bcedcbb9eb6a0304ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae919a78d63c59664cdaad9bb8e34bebf"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae919a78d63c59664cdaad9bb8e34bebf"></a>
const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArCondition.html#ae919a78d63c59664cdaad9bb8e34bebf">getError</a> (int messageNumber) const </td></tr>
<tr class="memdesc:ae919a78d63c59664cdaad9bb8e34bebf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Translate error into string. <br /></td></tr>
<tr class="separator:ae919a78d63c59664cdaad9bb8e34bebf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc965487fe42eaf062315ee409fca9e7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acc965487fe42eaf062315ee409fca9e7"></a>
const char *&#160;</td><td class="memItemRight" valign="bottom"><b>getLogName</b> ()</td></tr>
<tr class="separator:acc965487fe42eaf062315ee409fca9e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6eb476a0d677a713f6ecf8761c490340"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6eb476a0d677a713f6ecf8761c490340"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setLogName</b> (const char *logName)</td></tr>
<tr class="separator:a6eb476a0d677a713f6ecf8761c490340"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6c00c69e916c722cdce96d819a354b37"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6c00c69e916c722cdce96d819a354b37"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArCondition.html#a6c00c69e916c722cdce96d819a354b37">signal</a> ()</td></tr>
<tr class="memdesc:a6c00c69e916c722cdce96d819a354b37"><td class="mdescLeft">&#160;</td><td class="mdescRight">Signal the thread waiting. <br /></td></tr>
<tr class="separator:a6c00c69e916c722cdce96d819a354b37"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7cd1238b227485e9670947a4fca5ebd1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7cd1238b227485e9670947a4fca5ebd1"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArCondition.html#a7cd1238b227485e9670947a4fca5ebd1">timedWait</a> (unsigned int msecs)</td></tr>
<tr class="memdesc:a7cd1238b227485e9670947a4fca5ebd1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wait for a signal for a period of time in milliseconds. <br /></td></tr>
<tr class="separator:a7cd1238b227485e9670947a4fca5ebd1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af2b4daa37ab40fad88caee7c9c3075ef"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af2b4daa37ab40fad88caee7c9c3075ef"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArCondition.html#af2b4daa37ab40fad88caee7c9c3075ef">wait</a> ()</td></tr>
<tr class="memdesc:af2b4daa37ab40fad88caee7c9c3075ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wait for a signal. <br /></td></tr>
<tr class="separator:af2b4daa37ab40fad88caee7c9c3075ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aef9a7212064acc4fdec147f6ce0d93c8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aef9a7212064acc4fdec147f6ce0d93c8"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArCondition.html#aef9a7212064acc4fdec147f6ce0d93c8">~ArCondition</a> ()</td></tr>
<tr class="memdesc:aef9a7212064acc4fdec147f6ce0d93c8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Desctructor. <br /></td></tr>
<tr class="separator:aef9a7212064acc4fdec147f6ce0d93c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a929fd31f0eb09754b1259f909328fb9f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a929fd31f0eb09754b1259f909328fb9f"></a>
CondType&#160;</td><td class="memItemRight" valign="bottom"><b>myCond</b></td></tr>
<tr class="separator:a929fd31f0eb09754b1259f909328fb9f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a653def6318c13c79550a2e83d9e6b1a6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a653def6318c13c79550a2e83d9e6b1a6"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>myFailedInit</b></td></tr>
<tr class="separator:a653def6318c13c79550a2e83d9e6b1a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad8a8b57a18c44533faaae9ff52b9c79d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad8a8b57a18c44533faaae9ff52b9c79d"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>myLogName</b></td></tr>
<tr class="separator:ad8a8b57a18c44533faaae9ff52b9c79d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac31b954ce2972c03582359e6bd99786b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac31b954ce2972c03582359e6bd99786b"></a>
<a class="el" href="classArMutex.html">ArMutex</a>&#160;</td><td class="memItemRight" valign="bottom"><b>myMutex</b></td></tr>
<tr class="separator:ac31b954ce2972c03582359e6bd99786b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-static-attribs"></a>
Static Protected Attributes</h2></td></tr>
<tr class="memitem:a503d8d2febe1136e538a6ad603aab6e5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a503d8d2febe1136e538a6ad603aab6e5"></a>
static ArStrMap&#160;</td><td class="memItemRight" valign="bottom"><b>ourStrMap</b></td></tr>
<tr class="separator:a503d8d2febe1136e538a6ad603aab6e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Threading condition wrapper class. </p>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="threadExample_8cpp-example.html#_a1">threadExample.cpp</a>.</dd>
</dl></div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a class="anchor" id="a4382a649f89fb9d07ab9f58b19a6d936"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">anonymous enum</td>
        </tr>
      </table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="a4382a649f89fb9d07ab9f58b19a6d936a3f6f29f645b2ea501e9488a4d96ea6f4"></a>STATUS_FAILED&#160;</td><td class="fielddoc">
<p>General failure. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a4382a649f89fb9d07ab9f58b19a6d936ae43052d595425a1bfe513b595644ad45"></a>STATUS_FAILED_DESTROY&#160;</td><td class="fielddoc">
<p>Another thread is waiting on this condition so it can not be destroyed. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a4382a649f89fb9d07ab9f58b19a6d936aa37fed77069fa1ac5d22adb77bbf361e"></a>STATUS_FAILED_INIT&#160;</td><td class="fielddoc">
<p>Failed to initialize thread. Requested action is imposesible. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a4382a649f89fb9d07ab9f58b19a6d936ae06d2c7cba91b1db65a1d7beceba88ba"></a>STATUS_WAIT_TIMEDOUT&#160;</td><td class="fielddoc">
<p>The timedwait timed out before signaling. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a4382a649f89fb9d07ab9f58b19a6d936a1d3f032f0e06ee4095a1feb7e3af00f5"></a>STATUS_WAIT_INTR&#160;</td><td class="fielddoc">
<p>The wait was interupted by a signal. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a4382a649f89fb9d07ab9f58b19a6d936adeeec5c6ab916d4c79763f3e9e548e07"></a>STATUS_MUTEX_FAILED_INIT&#160;</td><td class="fielddoc">
<p>The underlying mutex failed to init. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a4382a649f89fb9d07ab9f58b19a6d936a55ca5a24fcc970ab4df4119c881ead71"></a>STATUS_MUTEX_FAILED&#160;</td><td class="fielddoc">
<p>The underlying mutex failed in some fashion. </p>
</td></tr>
</table>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>ArCondition.h</li>
<li>ArCondition_LIN.cpp</li>
<li>ArCondition_WIN.cpp</li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="classArCondition.html">ArCondition</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
  </ul>
</div>
</body>
</html>
